/status/app/proxy/forwardProxy/¶
Use
Use view the name of a forward proxy.
Parameters¶
name: Name of forward proxy object–Must use only a [limited character set](/R EST_API_Reference_Guide/000Getting_Started_with_the_REST_API/300Understanding_ the_REST_Hierarchy#Limited_Character_Set).
Data Key¶
The data key contains the name.
Note: When the default key is set to true, it means the object is set to its default. In this case, the system works as follows:
- On a PUT operation, the system ignores the data key. (Applicable only to /config nodes.)
- On a GET operation, the response only contains “default”: True and does not contain the data key.
- If the object has a base, it inherits its setting from its base.
See [Setting Objects to Their Default](https://docs.lineratesystems.com/093Rel ease_2.5/250REST_API_Reference_Guide/000Getting_Started_with_the_REST_API/300U nderstanding_the_REST_Hierarchy#Setting_Objects_to_Their_Default_(Default_Key) ).
Data Type¶
string
Default Data Value¶
“”
An object uses the default data value when one of the following is true:
- For objects without bases–When the object’s default key is true.
- For objects with bases–When the object’s default key is true, and when the default key is true for all of the object’s bases.
Default Allowed¶
False
Request Methods¶
GET
Examples¶
GET
curl -b cookie.jar -k https://host-117:8443/lrs/api/v1.0/status/app/proxy/forwardProxy/fp-01
GET Response
{"/status/app/proxy/forwardProxy/fp-01": {"data": "fp-01",
"default": False,
"defaultAllowed": False,
"deleteAllowed": True,
"numChildren": 8,
"type": "string"},
"httpResponseCode": 200,
"recurse": False,
"requestPath": "/status/app/proxy/forwardProxy/fp-01"}
GET (list children)
curl -b cookie.jar -k https://host-117:8443/lrs/api/v1.0/status/app/proxy/forwardProxy/fp-01?op=list
GET Response
{"/status/app/proxy/forwardProxy/fp-01": {"children": {"/status/app/proxy/forwardProxy/fp-01/adminStatus": {"default": True,
"defaultAllowed": True,
"deleteAllowed": False,
"numChildren": 0,
"type": "uint32"},
"/status/app/proxy/forwardProxy/fp-01/description": {"default": False,
"defaultAllowed": False,
"deleteAllowed": False,
"numChildren": 0,
"type": "string"},
"/status/app/proxy/forwardProxy/fp-01/ip": {"default": False,
"defaultAllowed": False,
"deleteAllowed": False,
"numChildren": 1,
"type": "subtree"},
"/status/app/proxy/forwardProxy/fp-01/mode": {"default": False,
"defaultAllowed": True,
"deleteAllowed": False,
"numChildren": 0,
"type": "string"},
"/status/app/proxy/forwardProxy/fp-01/serviceHttp": {"default": False,
"defaultAllowed": False,
"deleteAllowed": False,
"numChildren": 4,
"type": "subtree"},
"/status/app/proxy/forwardProxy/fp-01/serviceTcp": {"default": False,
"defaultAllowed": False,
"deleteAllowed": False,
"numChildren": 1,
"type": "subtree"},
"/status/app/proxy/forwardProxy/fp-01/serviceType": {"default": True,
"defaultAllowed": True,
"deleteAllowed": False,
"numChildren": 0,
"type": "uint32"},
"/status/app/proxy/forwardProxy/fp-01/virtualIP": {"default": False,
"defaultAllowed": False,
"deleteAllowed": False,
"numChildren": 1,
"type": "subtree"}},
"default": False,
"defaultAllowed": False,
"deleteAllowed": True,
"numChildren": 8,
"type": "subtree"},
"httpResponseCode": 200,
"recurse": False,
"requestPath": "/status/app/proxy/forwardProxy/fp-01"}
GET (recursively list children)
curl -b cookie.jar -k https://host-117:8443/lrs/api/v1.0/status/app/proxy/forw ardProxy/fp-01?level=recurse
- /status/app/proxy/forwardProxy/
1. Parameters 2. Data Key - Data Type
- Default Data Value 3. Default Allowed 4. Request Methods 5. Related 6. Examples